// 
// Entify project
//  
// Author:
//       Lauri Taimila <lauri@taimila.com>
// 
// Copyright (c) 2010 Lauri Taimila
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

using System;

namespace Taimila.Entify
{
	/// <summary>
	/// Value filter can be used to filter result set.
	/// </summary>
	public sealed class ValueFilter : IDataFilter
	{
		/// <summary>
		/// Create a new ValueFilter with Equal -operator.
		/// </summary>
		/// <param name="targetProperty">
		/// Name of the property. Filter this property. <see cref="System.String"/>
		/// </param>
		/// <param name="filterValue">
		/// Filter with this value. <see cref="System.Object"/>
		/// </param>
		public ValueFilter(string targetProperty, object filterValue)
		{
			this.FilterRule = FilterRule.Equal;
			this.TargetProperty = targetProperty;
			this.Value = filterValue;
		}
		
		/// <summary>
		/// Create a new ValueFilter.
		/// </summary>
		/// <param name="targetProperty">
		/// Name of the property. Filter this property. <see cref="System.String"/>
		/// </param>
		/// <param name="filterValue">
		/// Filter with this value. <see cref="System.Object"/>
		/// </param>
		/// <param name="filterRule">
		/// A <see cref="FilterRule"/>
		/// </param>
		public ValueFilter(string targetProperty, object filterValue, FilterRule filterRule) : this(targetProperty, filterValue)
		{
			this.FilterRule = filterRule;
		}
		
		/// <summary>
		/// Name of the property. Filter this property.
		/// </summary>
		public string TargetProperty
		{
			get;
			set;
		}
		
		/// <summary>
		/// Filter with this value.
		/// </summary>
		public object Value
		{
			get;
			set;
		}
		
		/// <summary>
		/// Filter rule to be applied with this value filter.
		/// </summary>
		public FilterRule FilterRule
		{
			get;
			set;
		}
	}
	
	/// <summary>
	/// Enumerates all filter rules that can be used with ValueFilter.
	/// </summary>
	public enum FilterRule
	{
		/// <summary>
		/// Equal -operator.
		/// </summary>
		Equal,
		
		/// <summary>
		/// Unequal -operator.
		/// </summary>
		Unequal,
		
		/// <summary>
		/// Greater than -operator.
		/// </summary>
		GreaterThan,
		
		/// <summary>
		/// Less than -operator.
		/// </summary>
		LessThan,
		
		/// <summary>
		/// Greater or equal than -operator.
		/// </summary>
		GreaterOrEqualThan,
		
		/// <summary>
		/// Less or equal than -operator.
		/// </summary>
		LessOrEqualThan
	}
}
